Message

Represents an HTTP message being sent or received.

@status_code will normally be a #SoupStatus value, eg, %SOUP_STATUS_OK, though of course it might actually be an unknown status code. @reason_phrase is the actual text returned from the server, which may or may not correspond to the "standard" description of @status_code. At any rate, it is almost certainly not localized, and not very descriptive even if it is in the user's language; you should not use @reason_phrase in user-visible messages. Rather, you should look at @status_code, and determine an end-user-appropriate message based on that and on what you were trying to do.

As described in the #SoupMessageBody documentation, the @request_body and @response_body <literal>data</literal> fields will not necessarily be filled in at all times. When the body fields are filled in, they will be terminated with a '\0' byte (which is not included in the <literal>length</literal>), so you can use them as ordinary C strings (assuming that you know that the body doesn't have any other '\0' bytes).

For a client-side #SoupMessage, @request_body's <literal>data</literal> is usually filled in right before libsoup writes the request to the network, but you should not count on this; use soup_message_body_flatten() if you want to ensure that <literal>data</literal> is filled in. If you are not using #SoupRequest to read the response, then @response_body's <literal>data</literal> will be filled in before #SoupMessage::finished is emitted. (If you are using #SoupRequest, then the message body is not accumulated by default, so @response_body's <literal>data</literal> will always be %NULL.)

For a server-side #SoupMessage, @request_body's %data will be filled in before #SoupMessage::got_body is emitted.

To prevent the %data field from being filled in at all (eg, if you are handling the data from a #SoupMessage::got_chunk, and so don't need to see it all at the end), call soup_message_body_set_accumulate() on @response_body or @request_body as appropriate, passing %FALSE.

class Message : ObjectG {}

Constructors

this
this(SoupMessage* soupMessage, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this(string method, string uriString)

Creates a new empty #SoupMessage, which will connect to @uri

this
this(string method, URI uri)

Creates a new empty #SoupMessage, which will connect to @uri

Members

Functions

addHeaderHandler
uint addHeaderHandler(string signal, string header, GCallback callback, void* userData)

Adds a signal handler to @msg for @signal, as with g_signal_connect(), but the @callback will only be run if @msg's incoming messages headers (that is, the <literal>request_headers</literal> for a client #SoupMessage, or the <literal>response_headers</literal> for a server #SoupMessage) contain a header named @header.

addOnContentSniffed
gulong addOnContentSniffed(void delegate(string, HashTable, Message) dlg, ConnectFlags connectFlags)

This signal is emitted after #SoupMessage::got-headers, and before the first #SoupMessage::got-chunk. If content sniffing is disabled, or no content sniffing will be performed, due to the sniffer deciding to trust the Content-Type sent by the server, this signal is emitted immediately after #SoupMessage::got-headers, and @type is %NULL.

addOnFinished
gulong addOnFinished(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted when all HTTP processing is finished for a message. (After #SoupMessage::got_body for client-side messages, or after #SoupMessage::wrote_body for server-side messages.)

addOnGotBody
gulong addOnGotBody(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted after receiving the complete message body. (For a server-side message, this means it has received the request body. For a client-side message, this means it has received the response body and is nearly done with the message.)

addOnGotChunk
gulong addOnGotChunk(void delegate(Buffer, Message) dlg, ConnectFlags connectFlags)

Emitted after receiving a chunk of a message body. Note that "chunk" in this context means any subpiece of the body, not necessarily the specific HTTP 1.1 chunks sent by the other side.

addOnGotHeaders
gulong addOnGotHeaders(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted after receiving all message headers for a message. (For a client-side message, this is after receiving the Status-Line and response headers; for a server-side message, it is after receiving the Request-Line and request headers.)

addOnGotInformational
gulong addOnGotInformational(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted after receiving a 1xx (Informational) response for a (client-side) message. The response_headers will be filled in with the headers associated with the informational response; however, those header values will be erased after this signal is done.

addOnNetwork
gulong addOnNetwork(void delegate(GSocketClientEvent, IOStream, Message) dlg, ConnectFlags connectFlags)

Emitted to indicate that some network-related event related to @msg has occurred. This essentially proxies the #GSocketClient::event signal, but only for events that occur while @msg "owns" the connection; if @msg is sent on an existing persistent connection, then this signal will not be emitted. (If you want to force the message to be sent on a new connection, set the %SOUP_MESSAGE_NEW_CONNECTION flag on it.)

addOnRestarted
gulong addOnRestarted(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted when a request that was already sent once is now being sent again (eg, because the first attempt received a redirection response, or because we needed to use authentication).

addOnStarting
gulong addOnStarting(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted just before a message is sent.

addOnWroteBody
gulong addOnWroteBody(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted immediately after writing the complete body for a message. (For a client-side message, this means that libsoup is done writing and is now waiting for the response from the server. For a server-side message, this means that libsoup has finished writing the response and is nearly done with the message.)

addOnWroteBodyData
gulong addOnWroteBodyData(void delegate(Buffer, Message) dlg, ConnectFlags connectFlags)

Emitted immediately after writing a portion of the message body to the network.

addOnWroteChunk
gulong addOnWroteChunk(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted immediately after writing a body chunk for a message.

addOnWroteHeaders
gulong addOnWroteHeaders(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted immediately after writing the headers for a message. (For a client-side message, this is after writing the request headers; for a server-side message, it is after writing the response headers.)

addOnWroteInformational
gulong addOnWroteInformational(void delegate(Message) dlg, ConnectFlags connectFlags)

Emitted immediately after writing a 1xx (Informational) response for a (server-side) message.

addStatusCodeHandler
uint addStatusCodeHandler(string signal, uint statusCode, GCallback callback, void* userData)

Adds a signal handler to @msg for @signal, as with g_signal_connect(), but the @callback will only be run if @msg has the status @status_code.

contentSniffed
void contentSniffed(string contentType, HashTable params)
disableFeature
void disableFeature(GType featureType)

This disables the actions of #SoupSessionFeature<!-- -->s with the given @feature_type (or a subclass of that type) on @msg, so that @msg is processed as though the feature(s) hadn't been added to the session. Eg, passing #SOUP_TYPE_CONTENT_SNIFFER for @feature_type will disable Content-Type sniffing on the message.

finished
void finished()
getAddress
Address getAddress()

Gets the address @msg's URI points to. After first setting the URI on a message, this will be unresolved, although the message's session will resolve it before sending the message.

getFirstParty
URI getFirstParty()

Gets @msg's first-party #SoupURI

getFlags
SoupMessageFlags getFlags()

Gets the flags on @msg

getHttpVersion
SoupHTTPVersion getHttpVersion()

Gets the HTTP version of @msg. This is the minimum of the version from the request and the version from the response.

getHttpsStatus
bool getHttpsStatus(TlsCertificate certificate, GTlsCertificateFlags errors)

If @msg is using https (or attempted to use https but got %SOUP_STATUS_SSL_FAILED), this retrieves the #GTlsCertificate associated with its connection, and the #GTlsCertificateFlags showing what problems, if any, have been found with that certificate.

getIsTopLevelNavigation
bool getIsTopLevelNavigation()
getMessageStruct
SoupMessage* getMessageStruct(bool transferOwnership)

Get the main Gtk struct

getPriority
SoupMessagePriority getPriority()

Retrieves the #SoupMessagePriority. If not set this value defaults to #SOUP_MESSAGE_PRIORITY_NORMAL.

getSiteForCookies
URI getSiteForCookies()

Gets @msg's site for cookies #SoupURI

getSoupRequest
Request getSoupRequest()

If @msg is associated with a #SoupRequest, this returns that request. Otherwise it returns %NULL.

getStruct
void* getStruct()

the main Gtk struct as a void*

getUri
URI getUri()

Gets @msg's URI

gotBody
void gotBody()
gotChunk
void gotChunk(Buffer chunk)
gotHeaders
void gotHeaders()
gotInformational
void gotInformational()
isFeatureDisabled
bool isFeatureDisabled(GType featureType)

Get whether #SoupSessionFeature<!-- -->s of the given @feature_type (or a subclass of that type) are disabled on @msg. See soup_message_disable_feature().

isKeepalive
bool isKeepalive()

Determines whether or not @msg's connection can be kept alive for further requests after processing @msg, based on the HTTP version, Connection header, etc.

restarted
void restarted()
setChunkAllocator
void setChunkAllocator(SoupChunkAllocator allocator, void* userData, GDestroyNotify destroyNotify)

Sets an alternate chunk-allocation function to use when reading @msg's body when using the traditional (ie, non-#SoupRequest<!-- -->-based) API. Every time data is available to read, libsoup will call @allocator, which should return a #SoupBuffer. (See #SoupChunkAllocator for additional details.) Libsoup will then read data from the network into that buffer, and update the buffer's <literal>length</literal> to indicate how much data it read.

setFirstParty
void setFirstParty(URI firstParty)

Sets @first_party as the main document #SoupURI for @msg. For details of when and how this is used refer to the documentation for #SoupCookieJarAcceptPolicy.

setFlags
void setFlags(SoupMessageFlags flags)

Sets the specified flags on @msg.

setHttpVersion
void setHttpVersion(SoupHTTPVersion version_)

Sets the HTTP version on @msg. The default version is %SOUP_HTTP_1_1. Setting it to %SOUP_HTTP_1_0 will prevent certain functionality from being used.

setIsTopLevelNavigation
void setIsTopLevelNavigation(bool isTopLevelNavigation)

See the same-site spec for more information.

setPriority
void setPriority(SoupMessagePriority priority)

Sets the priority of a message. Note that this won't have any effect unless used before the message is added to the session's message processing queue.

setRedirect
void setRedirect(uint statusCode, string redirectUri)

Sets @msg's status_code to @status_code and adds a Location header pointing to @redirect_uri. Use this from a #SoupServer when you want to redirect the client to another URI.

setRequest
void setRequest(string contentType, SoupMemoryUse reqUse, string reqBody)

Convenience function to set the request body of a #SoupMessage. If @content_type is %NULL, the request body must be empty as well.

setResponse
void setResponse(string contentType, SoupMemoryUse respUse, string respBody)

Convenience function to set the response body of a #SoupMessage. If @content_type is %NULL, the response body must be empty as well.

setSiteForCookies
void setSiteForCookies(URI siteForCookies)

Sets @site_for_cookies as the policy URL for same-site cookies for @msg.

setStatus
void setStatus(uint statusCode)

Sets @msg's status code to @status_code. If @status_code is a known value, it will also set @msg's reason_phrase.

setStatusFull
void setStatusFull(uint statusCode, string reasonPhrase)

Sets @msg's status code and reason phrase.

setUri
void setUri(URI uri)

Sets @msg's URI to @uri. If @msg has already been sent and you want to re-send it with the new URI, you need to call soup_session_requeue_message().

starting
void starting()
wroteBody
void wroteBody()
wroteBodyData
void wroteBodyData(Buffer chunk)
wroteChunk
void wroteChunk()
wroteHeaders
void wroteHeaders()
wroteInformational
void wroteInformational()

Static functions

getType
GType getType()

Variables

soupMessage
SoupMessage* soupMessage;

the main Gtk struct

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

ownedRef
bool ownedRef;
Undocumented in source.
getObjectGStruct
GObject* getObjectGStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

isGcRoot
bool isGcRoot;
Undocumented in source.
signals
DClosure[gulong] signals;
Undocumented in source.
destroyNotify
void destroyNotify(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify
void toggleNotify(ObjectG obj, GObject* object, int isLastRef)
Undocumented in source. Be warned that the author may not have intended to support it.
~this
~this()
Undocumented in source.
opCast
T opCast()
getDObject
RT getDObject(U obj, bool ownedRef)

Gets a D Object from the objects table of associations.

removeGcRoot
void removeGcRoot()
Undocumented in source. Be warned that the author may not have intended to support it.
setProperty
void setProperty(string propertyName, T value)
unref
deprecated void unref(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
doref
deprecated ObjectG doref(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
addOnNotify
gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags)

The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.

getType
GType getType()
compatControl
size_t compatControl(size_t what, void* data)
interfaceFindProperty
ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName)

Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

interfaceInstallProperty
void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec)

Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

interfaceListProperties
ParamSpec[] interfaceListProperties(TypeInterface gIface)

Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

addToggleRef
void addToggleRef(GToggleNotify notify, void* data)

Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.

addWeakPointer
void addWeakPointer(void* weakPointerLocation)

Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL.

bindProperty
Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags)

Creates a binding between @source_property on @source and @target_property on @target.

bindPropertyFull
Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify)

Complete version of g_object_bind_property().

bindPropertyWithClosures
Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom)

Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by the binding.

dupData
void* dupData(string key, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

dupQdata
void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

freezeNotify
void freezeNotify()

Increases the freeze count on @object. If the freeze count is non-zero, the emission of "notify" signals on @object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see g_object_set_data()).

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object.

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object.

getv
void getv(string[] names, Value[] values)

Gets @n_properties properties for an @object. Obtained properties will be set to @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether @object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property @property_name on @object.

notifyByPspec
void notifyByPspec(ParamSpec pspec)

Emits a "notify" signal for the property specified by @pspec on @object.

doref
alias doref = ref_
Undocumented in source.
ref_
ObjectG ref_()

Increases the reference count of @object.

refSink
ObjectG refSink()

Increase the reference count of @object, and possibly remove the floating[floating-ref] reference, if @object has a floating reference.

removeToggleRef
void removeToggleRef(GToggleNotify notify, void* data)

Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.

removeWeakPointer
void removeWeakPointer(void* weakPointerLocation)

Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer().

replaceData
bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy)

Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval.

replaceQdata
bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy)

Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setDataFull
void setDataFull(string key, void* data, GDestroyNotify destroy)

Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

setQdata
void setQdata(GQuark quark, void* data)

This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored.

setQdataFull
void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy)

This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

setv
void setv(string[] names, Value[] values)

Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata() and removes the @data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example: |[<!-- language="C" --> void object_add_to_user_list (GObject *object, const gchar *new_string) { // the quark, naming the object data GQuark quark_string_list = g_quark_from_static_string ("my-string-list"); // retrieve the old string list GList *list = g_object_steal_qdata (object, quark_string_list);

takeRef
ObjectG takeRef()

If @object is floating, sink it. Otherwise, do nothing.

thawNotify
void thawNotify()

Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on @object and when it reaches zero, queued "notify" signals are emitted.

unref
void unref()

Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

watchClosure
void watchClosure(Closure closure)

This function essentially limits the life time of the @closure to the life time of the object. That is, when the object is finalized, the @closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the @closure, to ensure that an extra reference count is held on @object during invocation of the @closure. Usually, this function will be called on closures that use this @object as closure data.

weakRef
void weakRef(GWeakNotify notify, void* data)

Adds a weak reference callback to an object. Weak references are used for notification when an object is disposed. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).

weakUnref
void weakUnref(GWeakNotify notify, void* data)

Removes a weak reference callback to an object.

clearObject
void clearObject(ObjectG objectPtr)

Clears a reference to a #GObject.

Meta